Package pl.wendigo.chrome.api.domsnapshot

Contains DevTools Protocol DOMSnapshot domain implementation accessible via DOMSnapshotDomain class.

Types

ArrayOfStrings

typealias ArrayOfStrings = List<StringIndex>

Index of the string in the strings table.

CaptureSnapshotRequest

data class CaptureSnapshotRequest(computedStyles: List<String>, includePaintOrder: Boolean?, includeDOMRects: Boolean?)

Represents request frame that can be used with DOMSnapshot#captureSnapshot operation call.

CaptureSnapshotResponse

data class CaptureSnapshotResponse(documents: List<DocumentSnapshot>, strings: List<String>)

Represents response frame that is returned from DOMSnapshot#captureSnapshot operation call.

ComputedStyle

data class ComputedStyle(properties: List<NameValue>)

A subset of the full ComputedStyle as defined by the request whitelist.

DocumentSnapshot

data class DocumentSnapshot(documentURL: StringIndex, title: StringIndex, baseURL: StringIndex, contentLanguage: StringIndex, encodingName: StringIndex, publicId: StringIndex, systemId: StringIndex, frameId: StringIndex, nodes: NodeTreeSnapshot, layout: LayoutTreeSnapshot, textBoxes: TextBoxSnapshot, scrollOffsetX: Double?, scrollOffsetY: Double?, contentWidth: Double?, contentHeight: Double?)

Document snapshot.

DOMNode

data class DOMNode(nodeType: Int, nodeName: String, nodeValue: String, textValue: String?, inputValue: String?, inputChecked: Boolean?, optionSelected: Boolean?, backendNodeId: BackendNodeId, childNodeIndexes: List<Int>?, attributes: List<NameValue>?, pseudoElementIndexes: List<Int>?, layoutNodeIndex: Int?, documentURL: String?, baseURL: String?, contentLanguage: String?, documentEncoding: String?, publicId: String?, systemId: String?, frameId: FrameId?, contentDocumentIndex: Int?, pseudoType: PseudoType?, shadowRootType: ShadowRootType?, isClickable: Boolean?, eventListeners: List<EventListener>?, currentSourceURL: String?, originURL: String?, scrollOffsetX: Double?, scrollOffsetY: Double?)

A Node in the DOM tree.

DOMSnapshotDomain

class DOMSnapshotDomain : Domain

This domain facilitates obtaining document snapshots with DOM, layout, and style information.

GetSnapshotRequest

data class GetSnapshotRequest(computedStyleWhitelist: List<String>, includeEventListeners: Boolean?, includePaintOrder: Boolean?, includeUserAgentShadowTree: Boolean?)

Represents request frame that can be used with DOMSnapshot#getSnapshot operation call.

GetSnapshotResponse

data class GetSnapshotResponse(domNodes: List<DOMNode>, layoutTreeNodes: List<LayoutTreeNode>, computedStyles: List<ComputedStyle>)

Represents response frame that is returned from DOMSnapshot#getSnapshot operation call.

InlineTextBox

data class InlineTextBox(boundingBox: Rect, startCharacterIndex: Int, numCharacters: Int)

Details of post layout rendered text positions.

LayoutTreeNode

data class LayoutTreeNode(domNodeIndex: Int, boundingBox: Rect, layoutText: String?, inlineTextNodes: List<InlineTextBox>?, styleIndex: Int?, paintOrder: Int?, isStackingContext: Boolean?)

Details of an element in the DOM tree with a LayoutObject.

LayoutTreeSnapshot

data class LayoutTreeSnapshot(nodeIndex: List<Int>, styles: List<ArrayOfStrings>, bounds: List<Rectangle>, text: List<StringIndex>, stackingContexts: RareBooleanData, paintOrders: List<Int>?, offsetRects: List<Rectangle>?, scrollRects: List<Rectangle>?, clientRects: List<Rectangle>?)

Table of details of an element in the DOM tree with a LayoutObject.

NameValue

data class NameValue(name: String, value: String)

A name/value pair.

NodeTreeSnapshot

data class NodeTreeSnapshot(parentIndex: List<Int>?, nodeType: List<Int>?, nodeName: List<StringIndex>?, nodeValue: List<StringIndex>?, backendNodeId: List<BackendNodeId>?, attributes: List<ArrayOfStrings>?, textValue: RareStringData?, inputValue: RareStringData?, inputChecked: RareBooleanData?, optionSelected: RareBooleanData?, contentDocumentIndex: RareIntegerData?, pseudoType: RareStringData?, isClickable: RareBooleanData?, currentSourceURL: RareStringData?, originURL: RareStringData?)

Table containing nodes.

RareBooleanData

data class RareBooleanData(index: List<Int>)

RareIntegerData

data class RareIntegerData(index: List<Int>, value: List<Int>)

RareStringData

data class RareStringData(index: List<Int>, value: List<StringIndex>)

Data that is only present on rare nodes.

Rectangle

typealias Rectangle = List<Double>

StringIndex

typealias StringIndex = Int

Index of the string in the strings table.

TextBoxSnapshot

data class TextBoxSnapshot(layoutIndex: List<Int>, bounds: List<Rectangle>, start: List<Int>, length: List<Int>)

Table of details of the post layout rendered text positions.